<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>octant</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;octant
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
      </table>
    </td>
  </tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package octant</h1><p class="nomargin-top"><span class="codelink"><a href="octant-pysrc.html">source&nbsp;code</a></span></p>
<pre class="literalblock">

OCTANT is a toolkit for working with ocean models on a C-Grid

Octant (Ocean C-grid model seTup and Analysis Toolkit) is based on the
python/numpy/matplotlib scientific python suite. NetCDF I/O is based on the
NetCDF4-python package. The toolkit contains general modeling tools for dealing
with arrays, diagnosing standard properties, curvilinear grid generation, and
interpolation. Specific tools are also included for ROMS and GETM.

External tools included for convinience include:
    
    delaunay : Delaunay interpolation
        Available at http://scipy.org/scipy/scikits
    
    sw : UNESCO seawater tools (seawater 1.1 by Bj&#248;rn &#197;dlandsvik)
        Available at http://www.imr.no/~bjorn/python/seawater/index.html

</pre>

<hr />
<div class="fields">      <p><strong>Version:</strong>
        0.2.0
      </p>
      <dl><dt>Authors:</dt>
        <dd>
          Robert Hetland &lt;hetland@tamu.edu&gt;,
          Richard Hofmeister &lt;richard.hofmeister@io-warnemuende.de&gt;
        </dd>
      </dl>
</div><!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Submodules</span></td>
</tr>
  <tr><td class="summary">
  <ul class="nomargin">
    <li> <strong class="uidlink"><a href="octant.cf-module.html">octant.cf</a></strong>: <em class="summary">cf.py - classes around CF compliant files</em>    </li>
    <li> <strong class="uidlink"><a href="octant.depths-module.html">octant.depths</a></strong>: <em class="summary">Various vertical coordinates</em>    </li>
    <li> <strong class="uidlink"><a href="octant.extern-module.html">octant.extern</a></strong>: <em class="summary">External packages</em>
    <ul>
    <li> <strong class="uidlink"><a href="octant.extern.greatcircle-module.html">octant.extern.greatcircle</a></strong>    </li>
    <li> <strong class="uidlink"><a href="octant.extern.kdtree-module.html">octant.extern.kdtree</a></strong>    </li>
    <li> <strong class="uidlink"><a href="octant.extern.pupynere-module.html">octant.extern.pupynere</a></strong>: <em class="summary">NetCDF reader.</em>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="octant.getm-module.html">octant.getm</a></strong>: <em class="summary">octant/getm - octant tools for GETM</em>    </li>
    <li> <strong class="uidlink"><a href="octant.grid-module.html">octant.grid</a></strong>: <em class="summary">Tools for creating and working with Arikawa C-Grids</em>    </li>
    <li> <strong class="uidlink"><a href="octant.io-module.html">octant.io</a></strong>: <em class="summary">A thin wrapper for netCDF4.Dataset and netCDF4.MFDataset</em>    </li>
    <li> <strong class="uidlink"><a href="octant.ocean-module.html">octant.ocean</a></strong>: <em class="summary">Model agnostic ocean tools</em>
    <ul>
    <li> <strong class="uidlink"><a href="octant.ocean.depths-module.html">octant.ocean.depths</a></strong>: <em class="summary">depths.py</em>    </li>
    <li> <strong class="uidlink"><a href="octant.ocean.state-module.html">octant.ocean.state</a></strong>: <em class="summary">Tools for working with oceanic data</em>    </li>
    <li> <strong class="uidlink"><a href="octant.ocean.step3d_t-module.html">octant.ocean.step3d_t</a></strong>: <em class="summary">step3d_t.py</em>    </li>
    <li> <strong class="uidlink"><a href="octant.ocean.time-module.html">octant.ocean.time</a></strong>    </li>
    <li> <strong class="uidlink"><a href="octant.ocean.velocity-module.html">octant.ocean.velocity</a></strong>: <em class="summary">velocity class.py</em>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="octant.plotting-module.html">octant.plotting</a></strong>: <em class="summary">octant.plotting - some plotting functions</em>    </li>
    <li> <strong class="uidlink"><a href="octant.roms-module.html">octant.roms</a></strong>: <em class="summary">Tools specific for the Regional Ocean Modeling System</em>    </li>
    <li> <strong class="uidlink"><a href="octant.seawater-module.html">octant.seawater</a></strong>: <em class="summary">Tools for working with seawater data.</em>    </li>
    <li> <strong class="uidlink"><a href="octant.slice-module.html">octant.slice</a></strong>: <em class="summary">Tools for slicing model fields.</em>    </li>
    <li> <strong class="uidlink"><a href="octant.sw-module.html">octant.sw</a></strong>: <em class="summary">Seawater -- Python functions for properties of sea water
   Bj&#248;rn &#197;dlandsvik &lt;bjorn@imr.no&gt;,
   Institute of Marine Research,
   Version 1.1, 13 November 2002</em>
    <ul>
    <li> <strong class="uidlink"><a href="octant.sw.density-module.html">octant.sw.density</a></strong>: <em class="summary">Seawater density module</em>    </li>
    <li> <strong class="uidlink"><a href="octant.sw.heat-module.html">octant.sw.heat</a></strong>: <em class="summary">Seawater heat module</em>    </li>
    <li> <strong class="uidlink"><a href="octant.sw.misc-module.html">octant.sw.misc</a></strong>: <em class="summary">Miscellaneous sea water functions</em>    </li>
    <li> <strong class="uidlink"><a href="octant.sw.salinity-module.html">octant.sw.salinity</a></strong>: <em class="summary">Seawater salinity module, providing salt and cond functions</em>    </li>
    <li> <strong class="uidlink"><a href="octant.sw.test-module.html">octant.sw.test</a></strong>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="octant.tools-module.html">octant.tools</a></strong>: <em class="summary">Tools for working with ROMS model input and output.</em>    </li>
  </ul></td></tr>
</table>

<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1
    on Mon Apr 20 11:56:29 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
